<!DOCTYPE html>
<html lang="zh-CN">
<head>
  <meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=2">
<meta name="theme-color" content="#222">
<meta name="generator" content="Hexo 4.2.1">
  <link rel="apple-touch-icon" sizes="180x180" href="/images/apple-touch-icon-next.png">
  <link rel="icon" type="image/png" sizes="32x32" href="/images/%E6%AD%A6%E6%B1%8932x32.png">
  <link rel="icon" type="image/png" sizes="16x16" href="/images/%E6%AD%A6%E6%B1%8916x16.png">
  <link rel="mask-icon" href="/images/logo.svg" color="#222">

<link rel="stylesheet" href="/css/main.css">


<link rel="stylesheet" href="/lib1/font-awesome/css/all.min.css">
  <link rel="stylesheet" href="/lib1/pace/pace-theme-center-simple.min.css">
  <script src="/lib1/pace/pace.min.js"></script>

<script id="hexo-configurations">
    var NexT = window.NexT || {};
    var CONFIG = {"hostname":"example.com","root":"/","scheme":"Gemini","version":"7.8.0","exturl":false,"sidebar":{"position":"left","display":"post","padding":18,"offset":12,"onmobile":false},"copycode":{"enable":true,"show_result":true,"style":null},"back2top":{"enable":true,"sidebar":false,"scrollpercent":false},"bookmark":{"enable":false,"color":"#222","save":"auto"},"fancybox":false,"mediumzoom":false,"lazyload":false,"pangu":false,"comments":{"style":"tabs","active":null,"storage":true,"lazyload":false,"nav":null},"algolia":{"hits":{"per_page":10},"labels":{"input_placeholder":"Search for Posts","hits_empty":"We didn't find any results for the search: ${query}","hits_stats":"${hits} results found in ${time} ms"}},"localsearch":{"enable":true,"trigger":"auto","top_n_per_article":1,"unescape":false,"preload":false},"motion":{"enable":true,"async":false,"transition":{"post_block":"fadeIn","post_header":"slideDownIn","post_body":"slideDownIn","coll_header":"slideLeftIn","sidebar":"slideUpIn"}},"path":"search.xml"};
  </script>

  <meta name="description" content="tsconfig.json概述如果一个目录下存在一个tsconfig.json文件，那么它意味着这个目录是TypeScript项目的根目录。 tsconfig.json文件中指定了用来编译这个项目的根文件和编译选项。 一个项目可以通过以下方式之一来编译： 使用tsconfig.json 不带任何输入文件的情况下调用tsc，编译器会从当前目录开始去查找tsconfig.json文件，逐级向上搜索父目">
<meta property="og:type" content="article">
<meta property="og:title" content="TypeScript项目配置">
<meta property="og:url" content="http://example.com/2021/12/02/%E7%9B%92%E9%A9%AC%E6%8A%80%E6%9C%AF%E6%A0%88%E5%88%9D%E5%AD%A6/typeScript%E9%A1%B9%E7%9B%AE%E9%85%8D%E7%BD%AE/index.html">
<meta property="og:site_name" content="Technological Blog">
<meta property="og:description" content="tsconfig.json概述如果一个目录下存在一个tsconfig.json文件，那么它意味着这个目录是TypeScript项目的根目录。 tsconfig.json文件中指定了用来编译这个项目的根文件和编译选项。 一个项目可以通过以下方式之一来编译： 使用tsconfig.json 不带任何输入文件的情况下调用tsc，编译器会从当前目录开始去查找tsconfig.json文件，逐级向上搜索父目">
<meta property="og:locale" content="zh_CN">
<meta property="article:published_time" content="2021-12-02T04:18:39.000Z">
<meta property="article:modified_time" content="2021-11-29T11:48:13.913Z">
<meta property="article:author" content="Li Yudong">
<meta property="article:tag" content="公司技术栈">
<meta name="twitter:card" content="summary">

<link rel="canonical" href="http://example.com/2021/12/02/%E7%9B%92%E9%A9%AC%E6%8A%80%E6%9C%AF%E6%A0%88%E5%88%9D%E5%AD%A6/typeScript%E9%A1%B9%E7%9B%AE%E9%85%8D%E7%BD%AE/">


<script id="page-configurations">
  // https://hexo.io/docs/variables.html
  CONFIG.page = {
    sidebar: "",
    isHome : false,
    isPost : true,
    lang   : 'zh-CN'
  };
</script>

  <title>TypeScript项目配置 | Technological Blog</title>
  






  <noscript>
  <style>
  .use-motion .brand,
  .use-motion .menu-item,
  .sidebar-inner,
  .use-motion .post-block,
  .use-motion .pagination,
  .use-motion .comments,
  .use-motion .post-header,
  .use-motion .post-body,
  .use-motion .collection-header { opacity: initial; }

  .use-motion .site-title,
  .use-motion .site-subtitle {
    opacity: initial;
    top: initial;
  }

  .use-motion .logo-line-before i { left: initial; }
  .use-motion .logo-line-after i { right: initial; }
  </style>
</noscript>

</head>

<body itemscope itemtype="http://schema.org/WebPage">
  <div class="container use-motion">
    <div class="headband"></div>

    <header class="header" itemscope itemtype="http://schema.org/WPHeader">
      <div class="header-inner"><div class="site-brand-container">
  <div class="site-nav-toggle">
    <div class="toggle" aria-label="切换导航栏">
      <span class="toggle-line toggle-line-first"></span>
      <span class="toggle-line toggle-line-middle"></span>
      <span class="toggle-line toggle-line-last"></span>
    </div>
  </div>

  <div class="site-meta">

    <a href="/" class="brand" rel="start">
      <span class="logo-line-before"><i></i></span>
      <h1 class="site-title">Technological Blog</h1>
      <span class="logo-line-after"><i></i></span>
    </a>
      <p class="site-subtitle" itemprop="description">IT小白的成长之旅</p>
  </div>

  <div class="site-nav-right">
    <div class="toggle popup-trigger">
        <i class="fa fa-search fa-fw fa-lg"></i>
    </div>
  </div>
</div>




<nav class="site-nav">
  <ul id="menu" class="main-menu menu">
        <li class="menu-item menu-item-about">

    <a href="/about/" rel="section"><i class="user fa-fw"></i>关于</a>

  </li>
        <li class="menu-item menu-item-tags">

    <a href="/tags/" rel="section"><i class="tags fa-fw"></i>标签<span class="badge">18</span></a>

  </li>
        <li class="menu-item menu-item-categories">

    <a href="/categories/" rel="section"><i class="th fa-fw"></i>分类<span class="badge">14</span></a>

  </li>
        <li class="menu-item menu-item-archives">

    <a href="/archives/" rel="section"><i class="archive fa-fw"></i>归档<span class="badge">95</span></a>

  </li>
      <li class="menu-item menu-item-search">
        <a role="button" class="popup-trigger"><i class="fa fa-search fa-fw"></i>搜索
        </a>
      </li>
  </ul>
</nav>



  <div class="search-pop-overlay">
    <div class="popup search-popup">
        <div class="search-header">
  <span class="search-icon">
    <i class="fa fa-search"></i>
  </span>
  <div class="search-input-container">
    <input autocomplete="off" autocapitalize="off"
           placeholder="搜索..." spellcheck="false"
           type="search" class="search-input">
  </div>
  <span class="popup-btn-close">
    <i class="fa fa-times-circle"></i>
  </span>
</div>
<div id="search-result">
  <div id="no-result">
    <i class="fa fa-spinner fa-pulse fa-5x fa-fw"></i>
  </div>
</div>

    </div>
  </div>

</div>
    </header>

    
  <div class="back-to-top">
    <i class="fa fa-arrow-up"></i>
    <span>0%</span>
  </div>

  <a href="https://github.com/tiarmor1" class="github-corner" title="Follow me on GitHub" aria-label="Follow me on GitHub" rel="noopener" target="_blank"><svg width="80" height="80" viewBox="0 0 250 250" aria-hidden="true"><path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path><path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path><path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path></svg></a>


    <main class="main">
      <div class="main-inner">
        <div class="content-wrap">
          

          <div class="content post posts-expand">
            

    
  
  

  <article itemscope itemtype="http://schema.org/Article" class="post-block" lang="zh-CN">
    <link itemprop="mainEntityOfPage" href="http://example.com/2021/12/02/%E7%9B%92%E9%A9%AC%E6%8A%80%E6%9C%AF%E6%A0%88%E5%88%9D%E5%AD%A6/typeScript%E9%A1%B9%E7%9B%AE%E9%85%8D%E7%BD%AE/">

    <span hidden itemprop="author" itemscope itemtype="http://schema.org/Person">
      <meta itemprop="image" content="/images/author.jpg">
      <meta itemprop="name" content="Li Yudong">
      <meta itemprop="description" content="">
    </span>
    
    <span hidden itemprop="publisher" itemscope itemtype="http://schema.org/Organization">
      <meta itemprop="name" content="Technological Blog">
    </span>
      <header class="post-header">
        <h1 class="post-title" itemprop="name headline">
          TypeScript项目配置
        </h1>
    
        <div class="post-meta">
            <span class="post-meta-item">
              <span class="post-meta-item-icon">
                <i class="far fa-calendar"></i>
              </span>
              <span class="post-meta-item-text">发表于</span>
    
              <time title="创建时间：2021-12-02 12:18:39" itemprop="dateCreated datePublished" datetime="2021-12-02T12:18:39+08:00">2021-12-02</time>
            </span>
              <span class="post-meta-item">
                <span class="post-meta-item-icon">
                  <i class="far fa-calendar-check"></i>
                </span>
                <span class="post-meta-item-text">更新于</span>
                <time title="修改时间：2021-11-29 19:48:13" itemprop="dateModified" datetime="2021-11-29T19:48:13+08:00">2021-11-29</time>
              </span>
            <span class="post-meta-item">
              <span class="post-meta-item-icon">
                <i class="far fa-folder"></i>
              </span>
              <span class="post-meta-item-text">分类于</span>
                <span itemprop="about" itemscope itemtype="http://schema.org/Thing">
                  <a href="/categories/%E7%9B%92%E9%A9%AC%E6%8A%80%E6%9C%AF%E6%A0%88/" itemprop="url" rel="index"><span itemprop="name">盒马技术栈</span></a>
                </span>
            </span>
    
          
    
        </div>
      </header>
    
    
    
    
    <div class="post-body" itemprop="articleBody">
    
      
        <h1 id="tsconfig-json"><a href="#tsconfig-json" class="headerlink" title="tsconfig.json"></a>tsconfig.json</h1><h2 id="概述"><a href="#概述" class="headerlink" title="概述"></a>概述</h2><p>如果一个目录下存在一个<code>tsconfig.json</code>文件，那么它意味着这个目录是TypeScript项目的根目录。 <code>tsconfig.json</code>文件中指定了用来编译这个项目的根文件和编译选项。 一个项目可以通过以下方式之一来编译：</p>
<h2 id="使用tsconfig-json"><a href="#使用tsconfig-json" class="headerlink" title="使用tsconfig.json"></a>使用tsconfig.json</h2><ul>
<li>不带任何输入文件的情况下调用<code>tsc</code>，编译器会从当前目录开始去查找<code>tsconfig.json</code>文件，逐级向上搜索父目录。</li>
<li>不带任何输入文件的情况下调用<code>tsc</code>，且使用命令行参数<code>--project</code>（或<code>-p</code>）指定一个包含<code>tsconfig.json</code>文件的目录。</li>
</ul>
<p>当命令行上指定了输入文件时，<code>tsconfig.json</code>文件会被忽略。</p>
<h2 id="示例"><a href="#示例" class="headerlink" title="示例"></a>示例</h2><p><code>tsconfig.json</code>示例文件:</p>
<ul>
<li><p>使用<code>&quot;files&quot;</code>属性</p>
<figure class="highlight json"><table><tr><td class="gutter"><pre><span class="line">1</span><br><span class="line">2</span><br><span class="line">3</span><br><span class="line">4</span><br><span class="line">5</span><br><span class="line">6</span><br><span class="line">7</span><br><span class="line">8</span><br><span class="line">9</span><br><span class="line">10</span><br><span class="line">11</span><br><span class="line">12</span><br><span class="line">13</span><br><span class="line">14</span><br><span class="line">15</span><br><span class="line">16</span><br><span class="line">17</span><br><span class="line">18</span><br><span class="line">19</span><br><span class="line">20</span><br><span class="line">21</span><br><span class="line">22</span><br><span class="line">23</span><br><span class="line">24</span><br></pre></td><td class="code"><pre><span class="line">&#123;</span><br><span class="line">    <span class="attr">"compilerOptions"</span>: &#123;</span><br><span class="line">        <span class="attr">"module"</span>: <span class="string">"commonjs"</span>,</span><br><span class="line">        <span class="attr">"noImplicitAny"</span>: <span class="literal">true</span>,</span><br><span class="line">        <span class="attr">"removeComments"</span>: <span class="literal">true</span>,</span><br><span class="line">        <span class="attr">"preserveConstEnums"</span>: <span class="literal">true</span>,</span><br><span class="line">        <span class="attr">"sourceMap"</span>: <span class="literal">true</span></span><br><span class="line">    &#125;,</span><br><span class="line">    <span class="attr">"files"</span>: [</span><br><span class="line">        <span class="string">"core.ts"</span>,</span><br><span class="line">        <span class="string">"sys.ts"</span>,</span><br><span class="line">        <span class="string">"types.ts"</span>,</span><br><span class="line">        <span class="string">"scanner.ts"</span>,</span><br><span class="line">        <span class="string">"parser.ts"</span>,</span><br><span class="line">        <span class="string">"utilities.ts"</span>,</span><br><span class="line">        <span class="string">"binder.ts"</span>,</span><br><span class="line">        <span class="string">"checker.ts"</span>,</span><br><span class="line">        <span class="string">"emitter.ts"</span>,</span><br><span class="line">        <span class="string">"program.ts"</span>,</span><br><span class="line">        <span class="string">"commandLineParser.ts"</span>,</span><br><span class="line">        <span class="string">"tsc.ts"</span>,</span><br><span class="line">        <span class="string">"diagnosticInformationMap.generated.ts"</span></span><br><span class="line">    ]</span><br><span class="line">&#125;</span><br></pre></td></tr></table></figure></li>
<li><p>使用<code>&quot;include&quot;</code>和<code>&quot;exclude&quot;</code>属性</p>
<figure class="highlight json"><table><tr><td class="gutter"><pre><span class="line">1</span><br><span class="line">2</span><br><span class="line">3</span><br><span class="line">4</span><br><span class="line">5</span><br><span class="line">6</span><br><span class="line">7</span><br><span class="line">8</span><br><span class="line">9</span><br><span class="line">10</span><br><span class="line">11</span><br><span class="line">12</span><br><span class="line">13</span><br><span class="line">14</span><br><span class="line">15</span><br><span class="line">16</span><br><span class="line">17</span><br></pre></td><td class="code"><pre><span class="line">&#123;</span><br><span class="line">    <span class="attr">"compilerOptions"</span>: &#123;</span><br><span class="line">        <span class="attr">"module"</span>: <span class="string">"system"</span>,</span><br><span class="line">        <span class="attr">"noImplicitAny"</span>: <span class="literal">true</span>,</span><br><span class="line">        <span class="attr">"removeComments"</span>: <span class="literal">true</span>,</span><br><span class="line">        <span class="attr">"preserveConstEnums"</span>: <span class="literal">true</span>,</span><br><span class="line">        <span class="attr">"outFile"</span>: <span class="string">"../../built/local/tsc.js"</span>,</span><br><span class="line">        <span class="attr">"sourceMap"</span>: <span class="literal">true</span></span><br><span class="line">    &#125;,</span><br><span class="line">    <span class="attr">"include"</span>: [</span><br><span class="line">        <span class="string">"src/**/*"</span></span><br><span class="line">    ],</span><br><span class="line">    <span class="attr">"exclude"</span>: [</span><br><span class="line">        <span class="string">"node_modules"</span>,</span><br><span class="line">        <span class="string">"**/*.spec.ts"</span></span><br><span class="line">    ]</span><br><span class="line">&#125;</span><br></pre></td></tr></table></figure></li>
</ul>
<h2 id="细节"><a href="#细节" class="headerlink" title="细节"></a>细节</h2><p><code>&quot;compilerOptions&quot;</code>可以被忽略，这时编译器会使用默认值。在这里查看完整的<a href="https://www.tslang.cn/docs/handbook/compiler-options.html" target="_blank" rel="noopener">编译器选项</a>列表。</p>
<p><code>&quot;files&quot;</code>指定一个包含相对或绝对文件路径的列表。 <code>&quot;include&quot;</code>和<code>&quot;exclude&quot;</code>属性指定一个文件glob匹配模式列表。 支持的glob通配符有：</p>
<ul>
<li><code>*</code> 匹配0或多个字符（不包括目录分隔符）</li>
<li><code>?</code> 匹配一个任意字符（不包括目录分隔符）</li>
<li><code>**/</code> 递归匹配任意子目录</li>
</ul>
<p>如果一个glob模式里的某部分只包含<code>*</code>或<code>.*</code>，那么仅有支持的文件扩展名类型被包含在内（比如默认<code>.ts</code>，<code>.tsx</code>，和<code>.d.ts</code>， 如果 <code>allowJs</code>设置能<code>true</code>还包含<code>.js</code>和<code>.jsx</code>）。</p>
<p>如果<code>&quot;files&quot;</code>和<code>&quot;include&quot;</code>都没有被指定，编译器默认包含当前目录和子目录下所有的TypeScript文件（<code>.ts</code>, <code>.d.ts</code> 和 <code>.tsx</code>），排除在<code>&quot;exclude&quot;</code>里指定的文件。JS文件（<code>.js</code>和<code>.jsx</code>）也被包含进来如果<code>allowJs</code>被设置成<code>true</code>。 如果指定了 <code>&quot;files&quot;</code>或<code>&quot;include&quot;</code>，编译器会将它们结合一并包含进来。 使用 <code>&quot;outDir&quot;</code>指定的目录下的文件永远会被编译器排除，除非你明确地使用<code>&quot;files&quot;</code>将其包含进来（这时就算用<code>exclude</code>指定也没用）。</p>
<p>使用<code>&quot;include&quot;</code>引入的文件可以使用<code>&quot;exclude&quot;</code>属性过滤。 然而，通过 <code>&quot;files&quot;</code>属性明确指定的文件却总是会被包含在内，不管<code>&quot;exclude&quot;</code>如何设置。 如果没有特殊指定， <code>&quot;exclude&quot;</code>默认情况下会排除<code>node_modules</code>，<code>bower_components</code>，<code>jspm_packages</code>和<code>&lt;outDir&gt;</code>目录。</p>
<p>任何被<code>&quot;files&quot;</code>或<code>&quot;include&quot;</code>指定的文件所引用的文件也会被包含进来。 <code>A.ts</code>引用了<code>B.ts</code>，因此<code>B.ts</code>不能被排除，除非引用它的<code>A.ts</code>在<code>&quot;exclude&quot;</code>列表中。</p>
<p>需要注意编译器不会去引入那些可能做为输出的文件；比如，假设我们包含了<code>index.ts</code>，那么<code>index.d.ts</code>和<code>index.js</code>会被排除在外。 通常来讲，不推荐只有扩展名的不同来区分同目录下的文件。</p>
<h1 id="项目引用"><a href="#项目引用" class="headerlink" title="项目引用"></a>项目引用</h1><p>工程引用是TypeScript 3.0的新特性，它支持将TypeScript程序的结构分割成更小的组成部分。</p>
<p>这样可以改善构建时间，强制在逻辑上对组件进行分离，更好地组织你的代码。</p>
<p>TypeScript 3.0还引入了<code>tsc</code>的一种新模式，即<code>--build</code>标记，它与工程引用协同工作可以加速TypeScript的构建。</p>
<h2 id="工程示例"><a href="#工程示例" class="headerlink" title="工程示例"></a>工程示例</h2><p>让我们来看一个非常普通的工程，并瞧瞧工程引用特性是如何帮助我们更好地组织代码的。 假设这个工程具有两个模块：<code>converter</code>和<code>unites</code>，以及相应的测试代码：</p>
<figure class="highlight shell"><table><tr><td class="gutter"><pre><span class="line">1</span><br><span class="line">2</span><br><span class="line">3</span><br><span class="line">4</span><br><span class="line">5</span><br></pre></td><td class="code"><pre><span class="line">/src/converter.ts</span><br><span class="line">/src/units.ts</span><br><span class="line">/test/converter-tests.ts</span><br><span class="line">/test/units-tests.ts</span><br><span class="line">/tsconfig.json</span><br></pre></td></tr></table></figure>

<p>测试文件导入相应的实现文件并进行测试：</p>
<figure class="highlight ts"><table><tr><td class="gutter"><pre><span class="line">1</span><br><span class="line">2</span><br><span class="line">3</span><br><span class="line">4</span><br></pre></td><td class="code"><pre><span class="line"><span class="comment">// converter-tests.ts</span></span><br><span class="line"><span class="keyword">import</span> * <span class="keyword">as</span> converter <span class="keyword">from</span> <span class="string">"../converter"</span>;</span><br><span class="line"></span><br><span class="line">assert.areEqual(converter.celsiusToFahrenheit(<span class="number">0</span>), <span class="number">32</span>);</span><br></pre></td></tr></table></figure>

<p>在之前，这种使用单一<code>tsconfig</code>文件的结构会稍显笨拙：</p>
<ul>
<li>实现文件也可以导入测试文件</li>
<li>无法同时构建<code>test</code>和<code>src</code>，除非把<code>src</code>也放在输出文件夹中，但通常并不想这样做</li>
<li>仅对实现文件的<em>内部</em>细节进行改动，必需再次对测试进行<em>类型检查</em>，尽管这是根本不必要的</li>
<li>仅对测试文件进行改动，必需再次对实现文件进行<em>类型检查</em>，尽管其实什么都没有变</li>
</ul>
<p>你可以使用多个<code>tsconfig</code>文件来解决<em>部分</em>问题，但是又会出现新问题：</p>
<ul>
<li>缺少内置的实时检查，因此你得多次运行<code>tsc</code></li>
<li>多次调用<code>tsc</code>会增加我们等待的时间</li>
<li><code>tsc -w</code>不能一次在多个配置文件上运行</li>
</ul>
<p>工程引用可以解决全部这些问题，而且还不止。</p>
<h2 id="何为工程引用？"><a href="#何为工程引用？" class="headerlink" title="何为工程引用？"></a>何为工程引用？</h2><p><code>tsconfig.json</code>增加了一个新的顶层属性<code>references</code>。它是一个对象的数组，指明要引用的工程：</p>
<figure class="highlight js"><table><tr><td class="gutter"><pre><span class="line">1</span><br><span class="line">2</span><br><span class="line">3</span><br><span class="line">4</span><br><span class="line">5</span><br><span class="line">6</span><br><span class="line">7</span><br><span class="line">8</span><br></pre></td><td class="code"><pre><span class="line">&#123;</span><br><span class="line">    <span class="string">"compilerOptions"</span>: &#123;</span><br><span class="line">        <span class="comment">// The usual</span></span><br><span class="line">    &#125;,</span><br><span class="line">    <span class="string">"references"</span>: [</span><br><span class="line">        &#123; <span class="string">"path"</span>: <span class="string">"../src"</span> &#125;</span><br><span class="line">    ]</span><br><span class="line">&#125;</span><br></pre></td></tr></table></figure>

<p>每个引用的<code>path</code>属性都可以指向到包含<code>tsconfig.json</code>文件的目录，或者直接指向到配置文件本身（名字是任意的）。</p>
<p>当你引用一个工程时，会发生下面的事：</p>
<ul>
<li>导入引用工程中的模块实际加载的是它<em>输出</em>的声明文件（<code>.d.ts</code>）。</li>
<li>如果引用的工程生成一个<code>outFile</code>，那么这个输出文件的<code>.d.ts</code>文件里的声明对于当前工程是可见的。</li>
<li>构建模式（后文）会根据需要自动地构建引用的工程。</li>
</ul>
<p>当你拆分成多个工程后，会显著地加速类型检查和编译，减少编辑器的内存占用，还会改善程序在逻辑上进行分组。</p>
<p><code>composite</code></p>
<p>引用的工程必须启用新的<code>composite</code>设置。 这个选项用于帮助TypeScript快速确定引用工程的输出文件位置。 若启用<code>composite</code>标记则会发生如下变动：</p>
<ul>
<li>对于<code>rootDir</code>设置，如果没有被显式指定，默认为包含<code>tsconfig</code>文件的目录</li>
<li>所有的实现文件必须匹配到某个<code>include</code>模式或在<code>files</code>数组里列出。如果违反了这个限制，<code>tsc</code>会提示你哪些文件未指定。</li>
<li>必须开启<code>declaration</code>选项。</li>
</ul>
<p><code>declarationMaps</code></p>
<p>我们增加了对<a href="https://github.com/Microsoft/TypeScript/issues/14479" target="_blank" rel="noopener">declaration source maps</a>的支持。 如果启用<code>--declarationMap</code>，在某些编辑器上，你可以使用诸如“Go to Definition”，重命名以及跨工程编辑文件等编辑器特性。</p>
<p>带<code>prepend</code>的<code>outFile</code>：</p>
<p>你可以在引用中使用<code>prepend</code>选项来启用前置某个依赖的输出：</p>
<figure class="highlight js"><table><tr><td class="gutter"><pre><span class="line">1</span><br><span class="line">2</span><br><span class="line">3</span><br></pre></td><td class="code"><pre><span class="line"><span class="string">"references"</span>: [</span><br><span class="line">     &#123; <span class="string">"path"</span>: <span class="string">"../utils"</span>, <span class="string">"prepend"</span>: <span class="literal">true</span> &#125;</span><br><span class="line"> ]</span><br></pre></td></tr></table></figure>

<p>前置工程会将工程的输出添加到当前工程的输出之前。 它对<code>.js</code>文件和<code>.d.ts</code>文件都有效，<code>source map</code>文件也同样会正确地生成。</p>
<p><code>tsc</code>永远只会使用磁盘上已经存在的文件来进行这个操作，因此你可能会创建出一个无法生成正确输出文件的工程，因为有些工程的输出可能会在结果文件中重覆了多次。 例如：</p>
<figure class="highlight plain"><table><tr><td class="gutter"><pre><span class="line">1</span><br><span class="line">2</span><br><span class="line">3</span><br><span class="line">4</span><br><span class="line">5</span><br><span class="line">6</span><br><span class="line">7</span><br></pre></td><td class="code"><pre><span class="line">   A</span><br><span class="line">  ^ ^</span><br><span class="line"> &#x2F;   \</span><br><span class="line">B     C</span><br><span class="line"> ^   ^</span><br><span class="line">  \ &#x2F;</span><br><span class="line">   D</span><br></pre></td></tr></table></figure>

<p>这种情况下，不能前置引用，因为在<code>D</code>的最终输出里会有两份<code>A</code>存在 - 这可能会发生未知错误。</p>
<h2 id="关于工程引用的说明"><a href="#关于工程引用的说明" class="headerlink" title="关于工程引用的说明"></a>关于工程引用的说明</h2><p>工程引用在某些方面需要你进行权衡.</p>
<p>因为有依赖的工程要使用它的依赖生成的<code>.d.ts</code>，因此你必须要检查相应构建后的输出<em>或</em>在下载源码后进行构建，然后才能在编辑器里自由地导航。 我们是在操控幕后的<code>.d.ts</code>生成过程，我们应该减少这种情况，但是目前还们建议提示开发者在下载源码后进行构建。</p>
<p>此外，为了兼容已有的构建流程，<code>tsc</code><em>不会</em>自动地构建依赖项，除非启用了<code>--build</code>选项。 下面让我们看看<code>--build</code>。</p>
<h2 id="TypeScript构建模式"><a href="#TypeScript构建模式" class="headerlink" title="TypeScript构建模式"></a>TypeScript构建模式</h2><p>在TypeScript工程里支持增量构建是个期待已久的功能。 在TypeScrpt 3.0里，你可以在<code>tsc</code>上使用<code>--build</code>标记。 它实际上是个新的<code>tsc</code>入口点，它更像是一个构建的协调员而不是简简单单的编译器。</p>
<p>运行<code>tsc --build</code>（简写<code>tsc -b</code>）会执行如下操作：</p>
<ul>
<li>找到所有引用的工程</li>
<li>检查它们是否为最新版本</li>
<li>按顺序构建非最新版本的工程</li>
</ul>
<p>可以给<code>tsc -b</code>指定多个配置文件地址（例如：<code>tsc -b src test</code>）。 如同<code>tsc -p</code>，如果配置文件名为<code>tsconfig.json</code>，那么文件名则可省略。</p>
<p><code>tsc -b</code>命令行</p>
<p>你可以指令任意数量的配置文件：</p>
<figure class="highlight shell"><table><tr><td class="gutter"><pre><span class="line">1</span><br><span class="line">2</span><br><span class="line">3</span><br></pre></td><td class="code"><pre><span class="line"><span class="meta">&gt;</span><span class="bash"> tsc -b                                <span class="comment"># Build the tsconfig.json in the current directory</span></span></span><br><span class="line"><span class="meta">&gt;</span><span class="bash"> tsc -b src                            <span class="comment"># Build src/tsconfig.json</span></span></span><br><span class="line"><span class="meta">&gt;</span><span class="bash"> tsc -b foo/release.tsconfig.json bar  <span class="comment"># Build foo/release.tsconfig.json and bar/tsconfig.json</span></span></span><br></pre></td></tr></table></figure>

<p>不需要担心命令行上指定的文件顺序 - <code>tsc</code>会根据需要重新进行排序，被依赖的项会优先构建。</p>
<p><code>tsc -b</code>还支持其它一些选项：</p>
<ul>
<li><code>--verbose</code>：打印详细的日志（可以与其它标记一起使用）</li>
<li><code>--dry</code>: 显示将要执行的操作但是并不真正进行这些操作</li>
<li><code>--clean</code>: 删除指定工程的输出（可以与<code>--dry</code>一起使用）</li>
<li><code>--force</code>: 把所有工程当作非最新版本对待</li>
<li><code>--watch</code>: 观察模式（可以与<code>--verbose</code>一起使用）</li>
</ul>
<h2 id="说明"><a href="#说明" class="headerlink" title="说明"></a>说明</h2><p>一般情况下，就算代码里有语法或类型错误，<code>tsc</code>也会生成输出（<code>.js</code>和<code>.d.ts</code>），除非你启用了<code>noEmitOnError</code>选项。 这在增量构建系统里就不好了 - 如果某个过期的依赖里有一个新的错误，那么你只能看到它<em>一次</em>，因为后续的构建会跳过这个最新的工程。 正是这个原因，<code>tsc -b</code>的作用就好比在所有工程上启用了<code>noEmitOnError</code>。</p>
<p>如果你想要提交所有的构建输出（<code>.js</code>, <code>.d.ts</code>, <code>.d.ts.map</code>等），你可能需要运行<code>--force</code>来构建，因为一些源码版本管理操作依赖于源码版本管理工具保存的本地拷贝和远程拷贝的时间戳。</p>
<h2 id="MSBuild"><a href="#MSBuild" class="headerlink" title="MSBuild"></a>MSBuild</h2><p>如果你的工程使用msbuild，你可以用下面的方式开启构建模式。</p>
<figure class="highlight xml"><table><tr><td class="gutter"><pre><span class="line">1</span><br></pre></td><td class="code"><pre><span class="line"><span class="tag">&lt;<span class="name">TypeScriptBuildMode</span>&gt;</span>true<span class="tag">&lt;/<span class="name">TypeScriptBuildMode</span>&gt;</span></span><br></pre></td></tr></table></figure>

<p>将这段代码添加到<code>proj</code>文件。它会自动地启用增量构建模式和清理工作。</p>
<p>注意，在使用<code>tsconfig.json</code> / <code>-p</code>时，已存在的TypeScript工程属性会被忽略 - 因此所有的设置需要在<code>tsconfig</code>文件里进行。</p>
<p>一些团队已经设置好了基于msbuild的构建流程，并且<code>tsconfig</code>文件具有和它们匹配的工程一致的<em>隐式</em>图序。 若你的项目如此，那么可以继续使用<code>msbuild</code>和<code>tsc -p</code>以及工程引用；它们是完全互通的。</p>
<h2 id="指导"><a href="#指导" class="headerlink" title="指导"></a>指导</h2><p>整体结构：</p>
<p>当<code>tsconfig.json</code>多了以后，通常会使用<a href="https://www.tslang.cn/docs/handbook/tsconfig-json.html" target="_blank" rel="noopener">配置文件继承</a>来集中管理公共的编译选项。 这样你就可以在一个文件里更改配置而不必在多个文件中进行修改。</p>
<p>另一个最佳实践是有一个<code>solution</code>级别的<code>tsconfig.json</code>文件，它仅仅用于引用所有的子工程。 它用于提供一个简单的入口；比如，在TypeScript源码里，我们可以简单地运行<code>tsc -b src</code>来构建所有的节点，因为我们在<code>src/tsconfig.json</code>文件里列出了所有的子工程。 注意从3.0开始，如果<code>tsconfig.json</code>文件里有至少一个工程引用<code>reference</code>，那么<code>files</code>数组为空的话也不会报错。</p>
<p>你可以在TypeScript源码仓库里看到这些模式 - 阅读<code>src/tsconfig_base.json</code>，<code>src/tsconfig.json</code>和<code>src/tsc/tsconfig.json</code>。</p>
<p>相对模块的结构：</p>
<p>通常地，将代码转成使用相对模块并不需要改动太多。 只需在某个给定父目录的每个子目录里放一个<code>tsconfig.json</code>文件，并相应添加<code>reference</code>。 然后将<code>outDir</code>指定为输出目录的子目录或将<code>rootDir</code>指定为所有工程的某个公共根目录。</p>
<p><code>outFile</code>的结构：</p>
<p>使用了<code>outFile</code>的编译输出结构十分灵活，因为相对路径是无关紧要的。 要注意的是，你通常不需要使用<code>prepend</code> - 因为这会改善构建时间并结省I/O。 TypeScript项目本身是一个好的参照 - 我们有一些“library”的工程和一些“endpoint”工程，“endpoint”工程会确保足够小并仅仅导入它们需要的“library”。</p>

    </div>
    
    
    
    
    <div>
      
        <div>
    
        <div style="text-align:center;color: #ccc;font-size:14px;">-------------本文结束<i class="fa fa-paw"></i>感谢您的阅读-------------</div>
    
</div>

      
    </div>
        <div class="reward-container">
  <div>坚持原创技术分享，您的支持将鼓励我继续创作！</div>
  <button onclick="var qr = document.getElementById('qr'); qr.style.display = (qr.style.display === 'none') ? 'block' : 'none';">
    打赏
  </button>
  <div id="qr" style="display: none;">
      
      <div style="display: inline-block;">
        <img src="/images/alipay.png" alt="Li Yudong 支付宝">
        <p>支付宝</p>
      </div>

  </div>
</div>

        

<div>
<ul class="post-copyright">
  <li class="post-copyright-author">
    <strong>本文作者： </strong>Li Yudong
  </li>
  <li class="post-copyright-link">
    <strong>本文链接：</strong>
    <a href="http://example.com/2021/12/02/%E7%9B%92%E9%A9%AC%E6%8A%80%E6%9C%AF%E6%A0%88%E5%88%9D%E5%AD%A6/typeScript%E9%A1%B9%E7%9B%AE%E9%85%8D%E7%BD%AE/" title="TypeScript项目配置">http://example.com/2021/12/02/盒马技术栈初学/typeScript项目配置/</a>
  </li>
  <li class="post-copyright-license">
    <strong>版权声明： </strong>本博客所有文章除特别声明外，均采用 <a href="https://creativecommons.org/licenses/by-nc-sa/4.0/" rel="noopener" target="_blank"><i class="fab fa-fw fa-creative-commons"></i>BY-NC-SA</a> 许可协议。转载请注明出处！
  </li>
</ul>
</div>

    
      <footer class="post-footer">
          <div class="post-tags">
              <a href="/tags/%E5%85%AC%E5%8F%B8%E6%8A%80%E6%9C%AF%E6%A0%88/" rel="tag"># 公司技术栈</a>
          </div>
    
        

    
        
    <div class="post-nav">
      <div class="post-nav-item">
    <a href="/2021/12/02/%E7%9B%92%E9%A9%AC%E6%8A%80%E6%9C%AF%E6%A0%88%E5%88%9D%E5%AD%A6/typeScript%E5%A3%B0%E6%98%8E%E6%96%87%E4%BB%B6/" rel="prev" title="TypeScript声明文件">
      <i class="fa fa-chevron-left"></i> TypeScript声明文件
    </a></div>
      <div class="post-nav-item">
    <a href="/2021/12/06/%E7%9B%92%E9%A9%AC%E6%8A%80%E6%9C%AF%E6%A0%88%E5%88%9D%E5%AD%A6/%E5%89%8D%E7%AB%AF%E7%8A%B6%E6%80%81%E7%AE%A1%E7%90%86%E6%80%BB%E7%BB%93/" rel="next" title="前端状态管理总结">
      前端状态管理总结 <i class="fa fa-chevron-right"></i>
    </a></div>
    </div>
      </footer>
    
  </article>
  
  
  



          </div>
          

<script>
  window.addEventListener('tabs:register', () => {
    let { activeClass } = CONFIG.comments;
    if (CONFIG.comments.storage) {
      activeClass = localStorage.getItem('comments_active') || activeClass;
    }
    if (activeClass) {
      let activeTab = document.querySelector(`a[href="#comment-${activeClass}"]`);
      if (activeTab) {
        activeTab.click();
      }
    }
  });
  if (CONFIG.comments.storage) {
    window.addEventListener('tabs:click', event => {
      if (!event.target.matches('.tabs-comment .tab-content .tab-pane')) return;
      let commentClass = event.target.classList[1];
      localStorage.setItem('comments_active', commentClass);
    });
  }
</script>

        </div>
          
  
  <div class="toggle sidebar-toggle">
    <span class="toggle-line toggle-line-first"></span>
    <span class="toggle-line toggle-line-middle"></span>
    <span class="toggle-line toggle-line-last"></span>
  </div>

  <aside class="sidebar">
    <div class="sidebar-inner">

      <ul class="sidebar-nav motion-element">
        <li class="sidebar-nav-toc">
          文章目录
        </li>
        <li class="sidebar-nav-overview">
          站点概览
        </li>
      </ul>

      <!--noindex-->
      <div class="post-toc-wrap sidebar-panel">
          <div class="post-toc motion-element"><ol class="nav"><li class="nav-item nav-level-1"><a class="nav-link" href="#tsconfig-json"><span class="nav-number">1.</span> <span class="nav-text">tsconfig.json</span></a><ol class="nav-child"><li class="nav-item nav-level-2"><a class="nav-link" href="#概述"><span class="nav-number">1.1.</span> <span class="nav-text">概述</span></a></li><li class="nav-item nav-level-2"><a class="nav-link" href="#使用tsconfig-json"><span class="nav-number">1.2.</span> <span class="nav-text">使用tsconfig.json</span></a></li><li class="nav-item nav-level-2"><a class="nav-link" href="#示例"><span class="nav-number">1.3.</span> <span class="nav-text">示例</span></a></li><li class="nav-item nav-level-2"><a class="nav-link" href="#细节"><span class="nav-number">1.4.</span> <span class="nav-text">细节</span></a></li></ol></li><li class="nav-item nav-level-1"><a class="nav-link" href="#项目引用"><span class="nav-number">2.</span> <span class="nav-text">项目引用</span></a><ol class="nav-child"><li class="nav-item nav-level-2"><a class="nav-link" href="#工程示例"><span class="nav-number">2.1.</span> <span class="nav-text">工程示例</span></a></li><li class="nav-item nav-level-2"><a class="nav-link" href="#何为工程引用？"><span class="nav-number">2.2.</span> <span class="nav-text">何为工程引用？</span></a></li><li class="nav-item nav-level-2"><a class="nav-link" href="#关于工程引用的说明"><span class="nav-number">2.3.</span> <span class="nav-text">关于工程引用的说明</span></a></li><li class="nav-item nav-level-2"><a class="nav-link" href="#TypeScript构建模式"><span class="nav-number">2.4.</span> <span class="nav-text">TypeScript构建模式</span></a></li><li class="nav-item nav-level-2"><a class="nav-link" href="#说明"><span class="nav-number">2.5.</span> <span class="nav-text">说明</span></a></li><li class="nav-item nav-level-2"><a class="nav-link" href="#MSBuild"><span class="nav-number">2.6.</span> <span class="nav-text">MSBuild</span></a></li><li class="nav-item nav-level-2"><a class="nav-link" href="#指导"><span class="nav-number">2.7.</span> <span class="nav-text">指导</span></a></li></ol></li></ol></div>
      </div>
      <!--/noindex-->

      <div class="site-overview-wrap sidebar-panel">
        <div class="site-author motion-element" itemprop="author" itemscope itemtype="http://schema.org/Person">
    <img class="site-author-image" itemprop="image" alt="Li Yudong"
      src="/images/author.jpg">
  <p class="site-author-name" itemprop="name">Li Yudong</p>
  <div class="site-description" itemprop="description"></div>
</div>
<div class="site-state-wrap motion-element">
  <nav class="site-state">
      <div class="site-state-item site-state-posts">
          <a href="/archives/">
        
          <span class="site-state-item-count">95</span>
          <span class="site-state-item-name">日志</span>
        </a>
      </div>
      <div class="site-state-item site-state-categories">
            <a href="/categories/">
          
        <span class="site-state-item-count">14</span>
        <span class="site-state-item-name">分类</span></a>
      </div>
      <div class="site-state-item site-state-tags">
            <a href="/tags/">
          
        <span class="site-state-item-count">18</span>
        <span class="site-state-item-name">标签</span></a>
      </div>
  </nav>
</div>
  <div class="links-of-author motion-element">
      <span class="links-of-author-item">
        <a href="https://github.com/tiarmor1" title="GitHub → https:&#x2F;&#x2F;github.com&#x2F;tiarmor1" rel="noopener" target="_blank"><i class="fab fa-github fa-fw"></i>GitHub</a>
      </span>
      <span class="links-of-author-item">
        <a href="mailto:1157019137@qq.com" title="E-Mail → mailto:1157019137@qq.com" rel="noopener" target="_blank"><i class="fa fa-envelope fa-fw"></i>E-Mail</a>
      </span>
  </div>
  <div class="cc-license motion-element" itemprop="license">
    <a href="https://creativecommons.org/licenses/by-nc-sa/4.0/" class="cc-opacity" rel="noopener" target="_blank"><img src="/images/cc-by-nc-sa.svg" alt="Creative Commons"></a>
  </div>



      </div>

    </div>
  </aside>
  <div id="sidebar-dimmer"></div>


      </div>
    </main>

    <footer class="footer">
      <div class="footer-inner">
        

        

<div class="copyright">
  
  &copy; 2020 – 
  <span itemprop="copyrightYear">2022</span>
  <span class="with-love">
    <i class="fa fa-heart"></i>
  </span>
  <span class="author" itemprop="copyrightHolder">Li Yudong</span>
</div>

        








      </div>
    </footer>
  </div>

  
  
  <script color='0,0,0' opacity='0.5' zIndex='-1' count='150' src="/lib1/canvas-nest/canvas-nest.min.js"></script>
  <script src="/lib1/anime.min.js"></script>
  <script src="/lib1/velocity/velocity.min.js"></script>
  <script src="/lib1/velocity/velocity.ui.min.js"></script>

<script src="/js/utils.js"></script>

<script src="/js/motion.js"></script>


<script src="/js/schemes/pisces.js"></script>


<script src="/js/next-boot.js"></script>




  




  
<script src="/js/local-search.js"></script>













  

  

  
   <canvas class="fireworks" style="position: fixed;left: 0;top: 0;z-index: 1; pointer-events: none;" ></canvas> 
   <script type="text/javascript" src="//cdn.bootcss.com/animejs/2.2.0/anime.min.js"></script> 
   <script type="text/javascript" src="/js/fireworks.js"></script>
  
</body>
</html>

